package jgamio.framework.application;

import jgamio.framework.application.KeyboardHandler.KeyEvent;
import jgamio.framework.application.KeyboardHandler.KeyPressType;

/**
 * Represents informations about events.
 * It is only a data structure for comfortable
 * saving of these data.
 *  
 * @author Tomas Zima
 */
class EventDescription
{
	/**
	 * <p>
	 * Constructor.
	 * </p>
	 * 
	 * <p>
	 * Saves all informations given by parameters into
	 * the attributes.
	 * </p>
	 * 
	 * @param key			Number of key (from LWJGL).
	 * @param eventNumber	User defined event number.
	 * @param type			Type of key press.
	 * 
	 * @see KeyPressType
	 * @see addGameEvent
	 * @see addMenuEvent
	 */
	public EventDescription(int key, KeyEvent event, KeyPressType type)
	{
		this.key			= key;
		this.event			= event;
		this.keyPressType	= type;
	}
	
	/** Number of key (from LWJGL). */
	int				key;
	
	/** User defined event number. */
	KeyEvent		event;
	
	/** Type of key press. */
	KeyPressType	keyPressType;
}